
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module szlcln.tableapi</title>
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="szlcln.html"><font color="#ffffff">szlcln</font></a>.tableapi</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/tatuhiko/work/scala.git/tableapi/szlcln/tableapi.py">/home/tatuhiko/work/scala.git/tableapi/szlcln/tableapi.py</a></font></td></tr></table>
    <p><tt>The&nbsp;APIs&nbsp;to&nbsp;handle&nbsp;file&nbsp;of&nbsp;Sawzall&nbsp;Clone&nbsp;Input/Output&nbsp;format.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="google.protobuf.internal.decoder.html">google.protobuf.internal.decoder</a><br>
<a href="google.protobuf.internal.encoder.html">google.protobuf.internal.encoder</a><br>
</td><td width="25%" valign=top><a href="os.html">os</a><br>
<a href="struct.html">struct</a><br>
</td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br>
<a href="sys.html">sys</a><br>
</td><td width="25%" valign=top><a href="szlcln.table_pb2.html">szlcln.table_pb2</a><br>
<a href="google.protobuf.internal.wire_format.html">google.protobuf.internal.wire_format</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="szlcln.tableapi.html#InvalidFormatException">InvalidFormatException</a>
</font></dt><dt><font face="helvetica, arial"><a href="szlcln.tableapi.html#ProtocException">ProtocException</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="szlcln.tableapi.html#TableWriter">TableWriter</a>
</font></dt></dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="InvalidFormatException">class <strong>InvalidFormatException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="exceptions.html#Exception">Exception</a>&nbsp;when&nbsp;<a href="#-readTable">readTable</a>()&nbsp;reads&nbsp;unkown&nbsp;tag.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="szlcln.tableapi.html#InvalidFormatException">InvalidFormatException</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="InvalidFormatException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#InvalidFormatException-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>

<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#InvalidFormatException-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>

<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="InvalidFormatException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#InvalidFormatException-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="InvalidFormatException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#InvalidFormatException-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="InvalidFormatException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#InvalidFormatException-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>

<dl><dt><a name="InvalidFormatException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#InvalidFormatException-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
&nbsp;<br>
Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>

<dl><dt><a name="InvalidFormatException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>

<dl><dt><a name="InvalidFormatException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#InvalidFormatException-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>

<dl><dt><a name="InvalidFormatException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#InvalidFormatException-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>

<dl><dt><a name="InvalidFormatException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>

<dl><dt><a name="InvalidFormatException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#InvalidFormatException-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>

<dl><dt><a name="InvalidFormatException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>

<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="ProtocException">class <strong>ProtocException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="exceptions.html#Exception">Exception</a>&nbsp;when&nbsp;'protoc'&nbsp;command&nbsp;fails.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="szlcln.tableapi.html#ProtocException">ProtocException</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="ProtocException-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ProtocException-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>

<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#ProtocException-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>

<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="ProtocException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ProtocException-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="ProtocException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ProtocException-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="ProtocException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ProtocException-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>

<dl><dt><a name="ProtocException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ProtocException-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
&nbsp;<br>
Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>

<dl><dt><a name="ProtocException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>

<dl><dt><a name="ProtocException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ProtocException-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>

<dl><dt><a name="ProtocException-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ProtocException-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>

<dl><dt><a name="ProtocException-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>

<dl><dt><a name="ProtocException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ProtocException-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>

<dl><dt><a name="ProtocException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>

<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="TableWriter">class <strong>TableWriter</strong></a></font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>The&nbsp;key/value&nbsp;pairs&nbsp;writer.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="TableWriter-__init__"><strong>__init__</strong></a>(self, filename, mode<font color="#909090">='w'</font>)</dt><dd><tt>Initializes&nbsp;object.<br>
This&nbsp;object&nbsp;opens&nbsp;the&nbsp;file&nbsp;specified&nbsp;by&nbsp;``filename``&nbsp;to&nbsp;write&nbsp;<br>
key/value&nbsp;pairs.</tt></dd></dl>

<dl><dt><a name="TableWriter-close"><strong>close</strong></a>(self)</dt><dd><tt>Closes&nbsp;the&nbsp;file.</tt></dd></dl>

<dl><dt><a name="TableWriter-write"><strong>write</strong></a>(self, key, value)</dt><dd><tt>Writes&nbsp;key/value&nbsp;pair&nbsp;to&nbsp;the&nbsp;file.<br>
Key&nbsp;and&nbsp;value&nbsp;are&nbsp;encoded&nbsp;by&nbsp;the&nbsp;method&nbsp;corresponding&nbsp;to&nbsp;type.<br>
&nbsp;<br>
WARNING:&nbsp;This&nbsp;function&nbsp;encodes&nbsp;string&nbsp;as&nbsp;bytes.</tt></dd></dl>

</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-decodeFloat"><strong>decodeFloat</strong></a>(bs)</dt><dd><tt>Decodes&nbsp;byte&nbsp;string&nbsp;as&nbsp;floating&nbsp;point&nbsp;number.</tt></dd></dl>
 <dl><dt><a name="-decodeInt"><strong>decodeInt</strong></a>(v)</dt><dd><tt>Decodes&nbsp;byte&nbsp;string&nbsp;as&nbsp;integer.</tt></dd></dl>
 <dl><dt><a name="-decodeString"><strong>decodeString</strong></a>(bs)</dt><dd><tt>Decodes&nbsp;byte&nbsp;string&nbsp;as&nbsp;string.</tt></dd></dl>
 <dl><dt><a name="-protoc"><strong>protoc</strong></a>(protofile)</dt><dd><tt>Compiles&nbsp;ProtocolBuffers&nbsp;DDL&nbsp;and&nbsp;imports&nbsp;compiled&nbsp;python&nbsp;file.</tt></dd></dl>
 <dl><dt><a name="-readTable"><strong>readTable</strong></a>(filename)</dt><dd><tt>Generator&nbsp;to&nbsp;read&nbsp;table.&nbsp;<br>
This&nbsp;function&nbsp;yields&nbsp;a&nbsp;tuple&nbsp;of&nbsp;``(key,&nbsp;value)``&nbsp;for&nbsp;each&nbsp;key/value&nbsp;pair&nbsp;in&nbsp;the&nbsp;file.<br>
&nbsp;<br>
WARN:&nbsp;Key&nbsp;and&nbsp;value&nbsp;have&nbsp;not&nbsp;been&nbsp;decoded.&nbsp;you&nbsp;must&nbsp;decode&nbsp;key&nbsp;and&nbsp;value.</tt></dd></dl>
</td></tr></table>
</body></html>